Coverage Requirements Discovery (CRD) System API - Implementation Template

Importing Templates into Anypoint Studio

1. In Studio, click the Exchange X icon in the upper left of the taskbar.
2. Log in with your Anypoint Platform credentials.
3. Search for the template.
4. Click Open.

Running Templates in Anypoint Studio

After you import your template into Studio, follow these configuration steps to run it.

CDS Services Application Configuration

The application requires a few things to be configured, mainly the system API connection information. Configure them in the properties file located in the config/properties folder.

• mule.env is the environment where the application is to be deployed. For a studio deployment, the recommended mule.env value is local.
• mule.encryptionKey is the encryption key for securing sensitive properties.

Please refer to the attached link on how to secure the configuration properties.

API Manager Configuration

The application requires API manager proxy configuration to allow CORS (Cross Origin Resource Sharing) support, required by the demo app used for testing. Therefore an entry in the property file is required to bind API Manager proxy with the Mule Runtime deployment using an API ID.
Refer to instructions from link for guidance on applying policies.

• api.autoDiscoveryId - sets the API ID from API Manager to bind proxy to runtime.

HTTPS Configuration

• https.host — sets the service host interface. It should be configured in config-<mule.env>.yaml file. (Defaults to 0.0.0.0 for all interfaces).
• https.port — sets the HTTPS service port number. It should be configured in config-<mule.env>.yaml file. (Default 8082).
• TLS Configuration - Keystore properties setup:
  • keystore.alias - sets the alias to the keystore. It should be configured in config-<mule.env>.yaml file.
  • keystore.path - sets the path to the key file. Key should be available in /src/main/resources/keystore. It should be configured in config-<mule.env>.yaml file.
  • keystore.keypass — sets keystore keypass to support HTTPS operation. It should be encrypted and configured in config-secured-<mule.env>.yaml file.
  • keystore.password— sets keystore password to support HTTPS operation. It should be encrypted and configured in config-secured-<mule.env>.yaml file.

Please refer to the attached link on how to generate the Keystore.

In Memory Database Configuration

1. Rename the database name in /src/main/resources/springbeans.xml bean for "org.apache.commons.dbcp2.BasicDataSource".
2. Database script file(create-db.sql) is present in /src/main/resources/dbscripts folder. It has the DB Create commands for schema and table.
3. Records to be loaded into the database are in /src/main/resources/dbfiles.
4. Java class DerbyInitializer.java has methods defined for creating records, fetching records and truncating table.
5. Files read from /src/main/resources/dbfiles/templates.md, are the data for rows in the table. Columns 2 and 3 in the file are inserted into columns hookId and respMessage respectively.

Tested and verified

This solution was developed and tested on Anypoint Studio 7.12.1 and Mule Runtime 4.4.0.

Running it

1. Right-click the template project folder.
2. Hover your mouse over 'Run as'.
3. Click Mule Application (configure).
4. Inside the dialog, select Environment and set the variable mule.env to the appropriate value (e.g., dev or local).
5. Inside the dialog, select Environment and set the variable mule.key to the property encryption key that you used to encrypt your secure properties.
6. In the Arguments tab in VM arguments text area, disable the gatekeeper to test locally using the arguments -Danypoint.platform.gatekeeper=disabled. This is required as API Manager configuration is used to configure CORS policy. When API Autodiscovery/API Manager configuration are used, gatekeeper needs to be disabled to run the API locally. Refer to https://help.mulesoft.com/s/article/API-returns-503-Service-Unavailable-error-to-clients for details.
7. Inside the dialog, go to 'Clear Application Data' select 'always' radio button.
8. Click Run

Deployment instructions for CloudHub using provided scripts

Ensure the Maven profile CloudHub-DEV has been properly configured in your settings.xml file. Reference can be found by downloading the Accelerator Setup Guide asset. Additional instructions are available in Accelerator Setup Guide - Configuring the Accelerator Build section.

Update the config-<env>.yaml properties appropriately and then use one of the following scripts to deploy the application to CloudHub:

• packageDeploy.sh or deployOnly.sh (Mac/Linux).
• packageDeploy.cmd or deployOnly.cmd (Windows).

In Memory Database Configuration for CloudHub

Post deployment to CloudHub, please complete the following steps, which kick off a scheduled flow to load the files provided in /src/main/resource/dbfiles as records to the database table defined in springbeans.xml:
1. RunTime Manager -> Select the runtime app instance.
2. Select Schedules from the list tabs available for the app.
3. Select the radio button available for the schedule "implementation_run-at-startup_Scheduler" and click on Run Now.

Testing it

• Use Advanced Rest Client or Postman to send a request over HTTPS. The template includes a postman collection in the src/test/resources folder. Update the collection variable(s) after successful import.